node-03 fs文件、shelljs

fs系统

fs模块中提供的方法一般有两种：
1. 同步[有返回值]，
2. 异步[有回调函数]；
带Sync的都是同步的，需要变量来接收；

在获取文件出错时，异步可以使用err来处理错误，同步可以使用try...catch来捕获

使用异步无法保证处理顺序，可以将后续操作放在异步的回调函数里面处理即可；

使用异步必须带回调函数，否则会抛出错误

文件路径：

process.cwd() 指定当前工作目录

一、不完全读写（对大文件操作的，可以分段操作）

对文件操作的方法

打开文件：fs.open()，fs.openSync()；

读取文件：fs.read()，fs.readSync()；

写文件：fs.write()，fs.writeSync()；

关闭文件：fs.close()，fs.closeSync()；

fs.readFile() 相当于fs.open()---fs.read()---fs.close()；

常用的文件系统标志

r：读取，文件不存在则报错；

r+：读写，文件不存在则报错；

w：写入，文件不存在则自动创建，如果有会覆盖；

w+：读写，文件不存在则自动创建；

a：追加内容，文件不存在则自动创建；

a+：读取并追加内容，文件不存在自动创建；

打开文件

异步：fs.open(path[,flags],callback);
path:读取文件的路径；
flags：文件系统标志，加引号；
callback：两个形参err,fd； fd是文件句柄，方便后续使用；
同步：fs.openSync返回一个fd；
读文件需要加'r'，写文件需要加'w'；
open主要是获取到fd，进行一步read和write操作；

fs.open(filepath,'r',(err,fd){ console.log('哈哈',fd) })

读文件

异步：fs.read(fd,buffer,offset,length,postion,callback);
- fd：指定文件中读取，在open之后的fd形参，指向已打开的文件；
- buffer：数据将写入的缓冲区，需要先声明一个缓冲区；
- offset：是buffer中从第几个开始读取；
- length：读取多少个字节；
- position：读取文件初始位置
- callback: 回调函数有三个参数(err,bytesRead,buffer)；
  - bytesRead：返回已经读取了多少个字节；
  - buffer：缓冲器里面的内容；
同步：fs.readSync返回一个bytesRead；

例：fs.read(fd,buffer,3,4,5,(err,bytesRead,buffer)=>{})；

const fs = require('fs')
let buf = Buffer.alloc(6) // 创建6字节长度的buf缓存对象
// 打开文件
fs.open('6.txt','r',(err,fd)=>{
    // 读取文件
    fs.read(fd,buf,0,3,0,(err,bytes,buffer)=>{
        console.log(buffer)
        // 可以继续读取
        fs.read(fd,buf,3,3,3,(err,bytes,buffer)=>{buffer.toString()})
    })
})

写入文件

需要在open之后

fs.write(fd,buffer,offset,length,position,callback);

文件关闭

fs.close(fd,callback)

二、完全读写

读取文件

fs.readFile(path[,options],callback);

option：默认为r；
callback：两个参数：err,data;

readFile加入一个对象：{encoding:'utf-8'}，可以不用.toString()来获取文件内容；

同步方式：fs.readFileSync(path[,option])；返回data；

fs.readFileSync(filepath,'utf-8')

fs.readFile(path.resolve(__dirname,'./1.txt'),(err,data)=>{
    console.log(data.toString()) //data默认是buffer
})

写入文件

fs.writeFile(file,data[,options],callback);

options：常用于要修改文件系统标志时，默认是'w'，所以需要改a用来追加；
修改标志：{flag:'a'}；
callback：一个err参数；

同步：fs.writeFileSync(file,data[,{flag:''}])没有返回值；\n可以换行

文件追加

异步：fs.appendFile(filename,data[,options],callback)

filename：读取的文件名
data：追加数据，文件追加的默认flag是a；

同步：fs.appendFileSync(filename,data[,options])

拷贝文件

异步：fs.copyFile(filenameA,filenameB,callback)

filenameA：原始文件名
filenameB：拷贝文件名

同步：fs.copyFileSync(filepath,filepath1)

删除文件

异步：fs.unlink(path,callback)

同步：fs.unlinkSync(path)

读取小文件时，直接使用readFile()或readFileSync()；

读取大文件时，使用文件流；

三、文件流

写文件

fs.createWriteStream(path[,options]);

两个常用事件：finish和error；

两个常用方法：write[写], end; end必须调用，无论有无参数；

创建之后是一个对象，里面有一些方法可以使用；

事件：.on调用事件，之后写一个回调函数(fs.on(event,callback))；

const fs = require('fs')
let ws = createWriteStream('hello.txt', {flags: 'w', encoding: 'utf-8'})
ws.on('open', function(){
    console.log('文件打开')
})
ws.on('ready', function(){
    console.log('文件写入已准备状态')
})
ws.on('close', function(){
    console.log('文件写入完成, 关闭')
})

ws.write('hello world!', function(err){
    if(err) {
        console.log(err)
    } else {
        console.log('内容流入完成')
    }
})
ws.write('hello2') // 上一个写完继续写下一个，进行流式写入
ws.end(function(){
    console.log('文件写入关闭')
})

// 文件打开
// 文件写入已准备状态
// 内容流入完成
// 文件写入关闭
// 文件写入完成, 关闭

读文件

fs.createReadStream(path[,options])；

五个常用事件：data,end,open,close,error，通过on监听

// 将文件打开并写入数据;    也可以直接使用管道流
const fs = require('fs')
let data = ''
const rs = fs.createReadStream('hello.txt')
rs.setEncoding('UTF8') // 也可以直接在创建时的第二个参数写入, 不设置encoding就是buffer

rs.on('open',()=>{ console.log('打开成功....') })
rs.on('data', chunk=>{
    // 当文件过大，比如1G时，会重复执行该事件, 最后流入结束；
    data += chunk
})
rs.on('close', () => { console.log('读取流结束') })

四、管道流pipe

readStream.pipe(writeStream)

将读取到的文件流入写入的文件；不用像文件流写那么多；

const fs = require('fs')
const rs = fs.createReadStream(`${__dirname}/...`)
const ws = fs.createWriteStream(`${__dirname}/...`)
rs.pipe(ws)
ws.on('finish', function(){
    console.log('写入完成')
    ws.end()
})

五、目录操作

创建新目录

异步：fs.mkdir(path[,options],callback)；

options：一个对象：
- recursive:true；递归创建（文件存在不报错）；

同步：fs.mkdirSync(path[,options]);没有返回值；

fs.existsSync(path) 判断目录是否存在的;

根目录上使用fs.mkdir()即使使用递归参数，都会报错；

fs.mkdir('/',{recursive:true},err=>{console.log(err)})

读取目录

异步：fs.readdir(path,callback);

同步：fs.readdirSync(path);

删除目录

异步：fs.rmdir(path,callback); 不能删除有文件的目录；

同步：fs.rmdirSync(path)；

实例1：删除空目录时使用rmdir就可以了，删除非空目录需要使用递归；

const fs = require('fs')
const path = require('path')

function getFile(dirName){
    let dirs = fs.readdirSync(dirName);    //打开文件
      //循环这个目录所有的文件
    dirs.forEach(item=>{ 
            //拼接一个完整的路径，注意使用形参路径;
        let curPath = path.resolve(dirName,item);
           //获取文件的状态，来判断文件是否是一个目录;
        let stats = fs.statSync(curPath);
        if(stats.isDirectory()){
            getFile(curPath);
        }else{
            fs.unlinkSync(curPath);
        }
    })
    fs.rmdirSync(dirName);   //删除这个文件；
}
getFile(`${__dirname}/test`)

实例2：快速重命名

（1）一次性替换所有文件的名字；

var fs = require('fs')
/**
*
*@param {String} dirName
*@param {String} oldStr
*@param {String} newStr
*/
function rename(dirName,oldStr,newStr){
    let dirArr = fs.readdirSync(dirName)
    for(var i=0;i<dirArr.length;i++){
        fs.renameSync(`${dirName}/${dirArr[i]}`,`${dirName}/${dirArr[i].replace(oldStr,newStr)}`)
    }
}
rename('./files','hello','pink')

（2）通过shift+右键打开PowerShell可以使用

bash

Get-ChildItem * | rename-item -newname {$_.name -replace 'hello','你好'}

（3）打开cmd，输入node，输入以下的代码即可

fs.readdirSync('./').forEach(i=>{fs.renameSync(`./${i}`,`./${i.replace('','')}`)})

六、文件操作

新建文件

writeFile的时候，如果没有就自动创建；

异步：fs.writeFile(path,data[,options],callback)；

fs.writeFile('./files','hello',(err)=>{
    console.log('创建文件成功')
})

同步：fs.writeFileSync(path, data[,options])

如果直接写文件名字，则创建到根目录，如果需要创建到指定目录，可以使用path.resolve给全路径

复制文件

fs.copyFile(src,dest,callback)；源文件，目标文件；

fs.copyFileSync(src,dest)

也可以使用流操作复制文件；

重命名文件

异步：fs.rename(oldPath,newPath,callback); 也可以重命名

同步：fs.renameSync(oldPath,newPath)；

删除文件

异步：fs.unlink(path,callback); 不能删除目录；

同步：fs.unlinkSync(path);

文件状态

异步：fs.stat(path,callback)

callback有两个参数：err，stats，stats是fs.stats，返回的是一个对象；
- stats.isDirectory()；是否是一个目录；
- stats.isFile()是否是一个文件；

同步：fs.statSync(path);

九、异步处理fs

插件安装：node-fs-extra

支持的使用方式：

为什么使用它：

copy 文件方便，不再需要判断文件夹和目录，没有直接新建

const fs = require('fs-extra')

// Async with promises:
fs.copy('/tmp/myfile', '/tmp/mynewfile')
  .then(() => console.log('success!'))
  .catch(err => console.error(err))

// Async with callbacks:
fs.copy('/tmp/myfile', '/tmp/mynewfile', err => {
  if (err) return console.error(err)
  console.log('success!')
})

// Sync:
try {
  fs.copySync('/tmp/myfile', '/tmp/mynewfile')
  console.log('success!')
} catch (err) {
  console.error(err)
}

// Async/Await:
async function copyFiles () {
  try {
    await fs.copy('/tmp/myfile', '/tmp/mynewfile')
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}

copyFiles()

import * as fse from 'fs-extra'
const path = './temp/data/list.json';
// 目录不存在会自动创建，将json格式直接写入文件
fse.outputJsonSync(dataPath, auditJson, { spaces: 2 })
// 读取出来直接是json
fse.readJSONSync(dataPath);

参考链接

https://juejin.im/post/5cdb76166fb9a032196ef1ff

node-03 fs文件、shelljs ​

fs系统 ​

一、不完全读写（对大文件操作的，可以分段操作） ​

对文件操作的方法 ​

常用的文件系统标志 ​

打开文件 ​

读文件 ​

写入文件 ​

文件关闭 ​

二、完全读写 ​

读取文件 ​

写入文件 ​

文件追加 ​

拷贝文件 ​

删除文件 ​

三、文件流 ​

写文件 ​

读文件 ​

四、管道流pipe ​

五、目录操作 ​

创建新目录 ​

读取目录 ​

删除目录 ​

六、文件操作 ​

新建文件 ​

复制文件 ​

重命名文件 ​

删除文件 ​

文件状态 ​

九、异步处理fs ​

参考链接 ​

node-03 fs文件、shelljs

fs系统

一、不完全读写（对大文件操作的，可以分段操作）

对文件操作的方法

常用的文件系统标志

打开文件

读文件

写入文件

文件关闭

二、完全读写

读取文件

写入文件

文件追加

拷贝文件

删除文件

三、文件流

写文件

读文件

四、管道流pipe

五、目录操作

创建新目录

读取目录

删除目录

六、文件操作

新建文件

复制文件

重命名文件

删除文件

文件状态

九、异步处理fs

参考链接